xfi:concept-label

xs:string=xfi:concept-label( $concept as xs:QName, $linkrole as xs:string?, $labelrole as xs:string?, $lang as xs:string)

Last updated on 18-06-2013 at 14:00:00Z.

Returns a string containing the label that has the specified link role, resource role, and language.

Documentation

Label is found by effective relationship after considering prohibition and overrides.

OIM Status

Supported

Parameters

Name Type Details
concept xs:QName The QName of the subject concept whose label is to be found.
linkrole xs:string? The linkrole value that specifies the network of effective relationships of arcs in which to find the concept's label. If omitted ("()" or "''") then the default link role is used.
labelrole xs:string? The label resource role value that is to be found. If omitted ("()" or "''") then the standard label is returned.
lang xs:string The language code of the label to be retrieved. If a label with exact match is not found, a closest-sublanguage is returned, e.g., if the argument to $lang is en-UK and a label is present with en, it is returned.

Output

Type: xs:string

Returns a label (if found) or an empty string (if no label found for QName given as concept, or for roles or for language code).

Conformance suite

90503 xfi.concept-label function testcase.xml [ download ]

Owners

Name Affiliation Email Start End
Herm Fischer UBMatrix / Mark V Systems fischer@markv.com 01-09-2008 at 00:00:00
Richard Ashby CoreFiling rna@corefiling.com 18-06-2013 at 14:00:00Z

Revisions

Name On Details
Herm Fischer 12-12-2008 at 00:00:00 Created the function definition.
Herm Fischer 12-12-2009 at 00:00:00 Removed reference to dynamically loaded instances from the xbrlinstance input.
Herm Fischer 09-09-2010 at 00:00:00 Changed role URIs to strings for cast-less coding and to be similar to fn:QName's $paramURI, an xs:string. Changed role URIs to allow () or '' for default values, to have similar style to xfi:concept-relationships.
Herm Fischer 14-09-2010 at 00:00:00 Modified language argument for compatibility with XPath fn:lang. (1) Changed language argument from xs:language to xs:string. (2) Changed description of label language matching to allow sublanguage matching as with fn:lang.
Richard Ashby 18-06-2013 at 14:00:00Z As per agreement on FWG call 2013/06/13, removed optional instance parameter and created separate CR function that uses it.